Class Flow.Level
Stores level metadata.
These are things things which aren't present in the compiled level file itself.
Members
| nameKey | (string) String key for the level's name. |
| scriptFile | (string) Level-specific Lua script file. |
| levelFile | (string) Compiled file path. |
| loadScreenFile | (string) Load screen image. |
| ambientTrack | (string) Initial ambient sound track to play. |
| layer1 | (Flow.SkyLayer) Primary sky cloud layer. |
| layer2 | (Flow.SkyLayer) Secondary sky cloud layer. |
| horizon1 | (Flow.Horizon) Primary horizon object. |
| horizon2 | (Flow.Horizon) Secondary horizon object. |
| starfield | (Flow.Starfield) Starfield in the sky. |
| lensFlare | (Flow.LensFlare) Global lens flare. |
| fog | (Flow.Fog) Global distance fog, with specified RGB color and distance. |
| storm | (bool) Enable flickering lightning in the sky. |
| weather | (WeatherType) Choose weather effect. |
| weatherStrength | (float) Choose weather strength. |
| laraType | (LaraType) Appearance of Lara. |
| rumble | (bool) Enable occasional screen shake effect. |
| farView | (int) The maximum draw distance for level. |
| resetHub | (bool) Reset hub data. |
| objects | (table of Flow.InventoryItems) A table of inventory object layout overrides. |
| secrets | (short) Set total secret count for current level. |
Functions
| Level() | Make a new Level object. |
Members
- nameKey
- (string) String key for the level's name. Corresponds to an entry in strings.lua.
- scriptFile
- (string) Level-specific Lua script file. Path of the Lua file holding the level's logic script, relative to the location of the Tomb Engine executable.
- levelFile
- (string) Compiled file path. This path is relative to the location of the TombEngine executable.
- loadScreenFile
- (string) Load screen image. Path of the level's load screen file (.png or .jpg), relative to the location of the Tomb Engine executable.
- ambientTrack
- (string) Initial ambient sound track to play. This is the filename of the track without the .wav extension.
- layer1
- (Flow.SkyLayer) Primary sky cloud layer.
- layer2
- (Flow.SkyLayer) Secondary sky cloud layer.
- horizon1
- (Flow.Horizon) Primary horizon object.
- horizon2
- (Flow.Horizon) Secondary horizon object.
- starfield
- (Flow.Starfield) Starfield in the sky.
- lensFlare
- (Flow.LensFlare) Global lens flare.
- fog
- (Flow.Fog) Global distance fog, with specified RGB color and distance. If not provided, distance fog will not be visible.
- storm
- (bool) Enable flickering lightning in the sky. Equivalent to classic TRLE's lightning setting, as in the TRC Ireland levels or TR4 Cairo levels.
- weather
-
(WeatherType) Choose weather effect.
Must be one of the values
WeatherType.None,WeatherType.Rain, orWeatherType.Snow. - weatherStrength
-
(float) Choose weather strength.
Must be value between
0.1and1.0. - laraType
-
(LaraType) Appearance of Lara. Must be either
LaraType.NormalorLaraType.Young. E.g.myLevel.laraType = LaraType.Youngwill make Lara appear as young (with two ponytails rendered). This setting does not affect ability to use weapons or flares. - rumble
- (bool) Enable occasional screen shake effect. As seen in TRC's Sinking Submarine.
- farView
- (int) The maximum draw distance for level. Given in sectors (blocks). Must be at least 4.
- resetHub
- (bool) Reset hub data. Resets the state for all previous levels, including items, flipmaps and statistics.
- objects
- (table of Flow.InventoryItems) A table of inventory object layout overrides.
- secrets
- (short) Set total secret count for current level.
Functions
- Level()
-
Make a new Level object.
Returns:
-
Level
a Level object.